Repository navigation
docs: guide for adding a notebook (CI, Colab, exclusion lists) - #174
Merged
Merged
Conversation
New docs/adding-notebooks.md explains what happens to a notebook after a PR: the Colab-bootstrap install cell and how to generate its pins (uv pip compile constrained to .github/colab-preinstalled.txt), how the CI test workflows run notebooks headlessly via run_notebook.py, headless-execution gotchas (plotly fig.show, cv2.imshow, interactive backends, input), and the three .github lists (colab-preinstalled, notebook-test-exclusions, notebook-colab-exclusions) and how they differ. Linked from the README submission section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview for this PR has been removed (PR closed). |
Add a 'Stream data from the DANDI Archive' section (and checklist item): notebooks should stream assets via remfile/fsspec rather than downloading files or reading local paths, so they run unattended in CI and Colab. Includes the remfile + DandiAPIClient pattern, disk-cache tip, and a note that hardcoded local paths are a common exclusion reason. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/adding-notebooks.md, a contributor guide for what happens to a notebook after a PR is opened. The root README's submission section already covers file layout +environment.yml, but nothing documented the CI/Colab machinery — this fills that gap and links to it from the README.Covers
uv pip compilewith--constraint .github/colab-preinstalled.txt,--python-version 3.12 --python-platform linux; why fully-pinned; thenbformat_minorgotcha.test-changed-notebooks.yml(PR) andtest-all-notebooks-weekly.yml, howrun_notebook.pyextracts pins → installs → stubs the install cell → runs underipython, and the "fresh-env, no preinstalled safety net" consequence.fig.show(),cv2.imshow,%matplotlib widget,input(),webbrowser.open) vs. what's fine (plt.show(),IFrame), with the one-line plotly renderer fix..githublists —colab-preinstalled.txt,notebook-test-exclusions.txt("skip in CI"),notebook-colab-exclusions.txt("no Colab button") — what each does and how they're independent.Docs-only; no notebook or workflow changes.
🤖 Generated with Claude Code